﻿/* ==============================================================================
*
*   Copyright (c) 2010, Pierre Favier
*   All rights reserved.
*
*   NTasking is free software: you can redistribute it and/or modify it
*   under the terms of the GNU General Public License as published by the
*   Free Software Foundation.
*
*   Redistribution and use in source and binary forms, with or without
*   modification, are permitted provided that the following conditions
*   are met:
*
*   -   Redistributions of source code must retain the above copyright notice,
*       this list of conditions and the following disclaimer.
*
*   -   Redistributions in binary form must reproduce the above
*       copyright notice, this list of conditions and the following
*       disclaimer in the documentation and/or other materials
*       provided with the distribution.
*
*   THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
*   WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
*   OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
*   DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
*   BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
*   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
*   TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
*   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
*   ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
*   TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
*   THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
*   SUCH DAMAGE.
*
* ============================================================================== */

using System.Threading;

namespace NTasking
{

    /// <summary>
    /// The <see cref="ITask"/> interface defines the methods and properties common to all <see cref="Task"/>
    /// and <see cref="NTasking.Internals.ThreadWrapper"/> classes
    /// </summary>
    public interface ITask
    {

        /// <summary>
        /// Gets or Sets the name of this instance
        /// </summary>
        /// <value>The name of the current instance</value>
        string Name { get; set; }


        /// <summary>
        /// Gets or sets a value defining the desired <see cref="ThreadPriority"/> of the instance
        /// </summary>
        /// <value>The defined priority of the current instance</value>
        ThreadPriority Priority { get; set; }


        /// <summary>
        /// Gets a value indicating the current <see cref="ThreadPriority"/> of the instance.
        /// This current <see cref="ThreadPriority"/> is normaly the value defined in the
        /// <see cref="ITask.Priority"/> but can differ due to Ada priority inheritance rules.
        /// </summary>
        /// <value>
        /// The current <see cref="ThreadPriority"/> of the instance
        /// </value>
        ThreadPriority CurrentPriority { get; }


        /// <summary>
        /// Gets a value indicating the current status of this instance.
        /// </summary>
        /// <value>
        /// The current status of this instance.
        /// </value>
        TaskStatus TaskStatus { get; }


        /// <summary>
        /// Gets a value indicating whether the current instance is Callable.
        /// </summary>
        /// <value><c>true</c> if the current instance is Callable, <c>false</c> otherwise.</value>
        bool Callable { get; }


        /// <summary>
        /// Gets a value indicating whether the current instance is Terminated.
        /// </summary>
        /// <value><c>true</c> if the current instance is Terminated, <c>false</c> otherwise.</value>
        bool Terminated { get; }


        /// <summary>
        /// Aborts the current instance.
        /// </summary>
        void Abort();

    }

}
